Chatvolt Mcp

@Miguel J N Martinez

5 months ago

A Model Context Protocol server that wraps the Chatvolt API, providing tools to manage agents, datastores, and CRM workflows. This is a TypeScript-based MCP server that provides tools to interact with Chatvolt.

Overview Tools Comments

Overview

Chatvolt MCP Server Overview

This document provides a summary of the chatvolt-mcp server, a Model Context Protocol (MCP) server designed to interact with the Chatvolt API.

Introduction

The Chatvolt MCP Server is a TypeScript-based application that exposes the Chatvolt API as a set of tools. It allows for the management of agents, datastores, and CRM workflows within a system that supports MCP.

Installation

To use the server, you can run it directly with npx:

npx chatvolt-mcp

For integration with Roo, you need to configure the mcp.json file, specifying the command, arguments, and the necessary CHATVOLT_API_KEY environment variable.

Tools

The server provides a comprehensive set of tools categorized into three main groups:

Agent Tools

These tools are for managing Chatvolt agents.

get_agent: Fetches an agent by ID or handle.
create_agent: Creates a new agent.
list_agents: Lists all available agents.
update_agent: Partially updates an existing agent.
delete_agent: Deletes an agent by its ID.
agent_query: Sends a query to a specified agent.
enable_disable_agent_integration: Enables or disables integrations like WhatsApp, Telegram, etc.

CRM Tools

These tools manage CRM scenarios and steps.

list_crm_scenarios: Lists CRM scenarios, with an option to filter by agent.
create_crm_scenario: Creates a new CRM scenario.
update_crm_scenario: Updates an existing CRM scenario.
delete_crm_scenario: Deletes a CRM scenario.
list_crm_steps: Lists all steps for a specific CRM scenario.
create_crm_step: Creates a new step within a CRM scenario.
update_crm_step: Updates an existing CRM step.
delete_crm_step: Deletes a CRM step.

Datastore Tools

These tools are for managing datastores and datasources.

list_datastores: Lists all Chatvolt datastores.
get_datastore: Retrieves a specific datastore and its datasources.
create_datastore: Creates a new datastore.
create_datasource: Adds a new datasource (e.g., a text file) to a datastore.

Configuration

The server requires a CHATVOLT_API_KEY to be set as an environment variable for authentication with the Chatvolt API.

export CHATVOLT_API_KEY="your_api_key_here"

Development

The project includes scripts for standard development workflows:

npm install: Installs dependencies.
npm run build: Builds the TypeScript source code.
npm run watch: Runs the builder in watch mode for development.
npm run inspector: Launches the MCP Inspector for debugging the server's communication.

Try in Playground

Server Config

{
  "mcpServers": {
    "chatvolt-mcp": {
      "command": "npx",
      "args": [
        "chatvolt-mcp"
      ],
      "env": {
        "CHATVOLT_API_KEY": "YOUR KEY FROM chatvolt.ai"
      },
      "disabled": false,
      "alwaysAllow": [
        "get_agent"
      ]
    }
  }
}

Build with ShipAny.